<?php
/*
    Download page
    Copyright (C) 2015  Leah Rowe <info@minifree.org>

    This document is released under Creative Commons Zero 1.0 Universal
    Public Domain License.

    See <https://creativecommons.org/publicdomain/zero/1.0/legalcode>
*/
	header('Content-type: text/html; charset=utf-8');
	ob_start();
	include_once "../common/variables.php";
	include_once "../common/functions.php";
?>
<!DOCTYPE html>
<html>
<head>
	<link rel="stylesheet" type="text/css" href="../common/css/main.css" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
	<title><?php echo gettext("Information for libreboot developers and contributors"); ?></title>
</head>

<body>

	<div>

		<h1 id="pagetop"><?php echo gettext("Information for libreboot developers and contributors"); ?></h1>

			<p>
				Useful information, related to libreboot development, including links to the Git repositories where
				development is done.
			</p>

				<ul class="c">
					<li><a href="#howtohelp">How can I help the libreboot project?</a></li>
					<li><a href="#guidelines">General guidelines for submitting patches</a></li>
					<li><strong><a href="#download">How to download from the Git repository</a></strong></li>
					<li><strong><a href="#sendpatch">How to submit your patches</a></strong></li>
					<li><a href="#githosting">List of recommended Git hosting providers</a></li>
					<li><strong><a href="#contrib">How to use git, for creating patches</a></strong></li>
				</ul>

			<p><a href="../"><?php echo gettext("Back to home page"); ?></a></p>

	</div>

	<div>

		<h2 id="howtohelp">How can I help the libreboot project? <span class="r"><a href="#howtohelp">#howtohelp</a></span></h2>
            <p>
                <strong>At any given time, here is a list of tasks if there are any, for the next stable release of libreboot:
                <a href="../tasks/">click here</a></strong>
            </p>
			<p>
				There are many ways that you can assist the libreboot project. We have a <a href="../tasks/">list of tasks that need to be completed</a>,
				which you can work on (you can also add to that list). Generally speaking, adding support for more hardware is a priority for the libreboot project.
				Information about building libreboot can be found at <a href="../docs/git/">here</a>.
			</p>
			<p>
				We especially need more skilled coreboot hackers to do work that will benefit the libreboot project. This includes porting new boards to coreboot, which are likely to be valid candidates for libreboot.
			</p>
			<p>
				Learn libreboot from the inside out; download the git repository, and study libreboot. We need more full-time developers
				who can help to maintain the project.
			</p>
			<p>
				Not a developer? You can still help!
			</p>
				<ul class="c">
					<li>Work towards convincing hardware manufacturers and designers to start caring about free software. Perhaps even build your own hardware.</li>
					<li>Spread the word about libreboot! Tell your friends about it, and talk about it on public internet-based discussion networks (e.g. <em>social networks</em>).</li>
					<li>Install and use libreboot yourself, showing it to others and promoting it that
					way. <a href="../suppliers/">Computers with libreboot preinstalled are also available</a>, which helps to fund the libreboot project.</li>
					<li>Help others to install libreboot. For example, organize an installation workshop at your local hackerspace.</li>
					<li>Assist with improving the libreboot documentation, so that others may find it easier to use.</li>
				</ul>

	</div>

	<div>

		<h2 id="guidelines">General guidelines for submitting patches  <span class="r"><a href="#guidelines">#guidelines</a></span></h2>
			<p>
				Some people put their name on their work, for recognition, and it's OK if you want to do that; however, the libreboot project does not require this. Some projects
				(such as coreboot) require a legal name, and this can be problematic for certain groups of people.
			</p>
			<p>
				Using your legal name is <strong>not</strong> required when submitting patches to libreboot. For reasons why we have this policy, read <a href='http://geekfeminism.org/2012/09/29/quick-hit-how-git-shows-the-patriarchal-nature-of-the-software-industry/'>this article</a>. You can use any name of your choosing, or your company name (if you have one), if you want or need to do that. You can also
				submit patches <em>without a name</em>, if you want or need to do that (instructions are provided on this page). Also, read <a href='http://www.kalzumeus.com/2010/06/17/falsehoods-programmers-believe-about-names/'>this article</a>. Unfortunately, git appears to be stuck with these problems, when an author changes their name, and we don't have a concrete answer to it.
				As far as we know, publishing your legal name isn't even required for copyright purposes; in fact, &quot;pen&quot; names are commonly used by literary authors (computer programs are literary works).
			</p>
			<p>
				When submitting any kind of documentation, try not to use the terms him/her, she/he, his/her, or anything that is gender biased. <strong>Use their, they, them, those people, that person, and so on.</strong> <a href="https://gist.githubusercontent.com/0xabad1dea/8870b192fd1758743f66/raw/a230fa3438ce60c538dba31830fa88143245b719/singularthey.md">You are making a huge difference</a>. 
			</p>
			<p>
				<?php echo gettext("Generally speaking, using the same license as the file that you are modifying is much simpler."); ?>
				<?php echo gettext("If you are submitting new files, please make sure that they are under a free license (<a href='https://copyleft.org/'>copyleft</a> preferred)."); ?>
				<?php echo gettext("You can find a list on:"); ?> <a href="https://www.gnu.org/licenses/license-list.html">https://www.gnu.org/licenses/license-list.html</a>
                (we will reject any documentation released under the GNU Free Documentation License, for reasons mentioned in <a href="../why-not-gnu/">../why-not-gnu/</a>).
                NOTE:
				not putting a copyright notice on a work does not mean it lacks copyright. Copyright is <em>automatic</em> in most countries. Not putting a license
				on a work also does not make that work <em>free</em>; you have to declare a free license, otherwise the default, restrictive copyright laws apply for those
				who wish to do anything with your work. Always put a license on your work!
			</p>

			<p>
				<a href="#pagetop">Back to top of page</a>
			</p>

	</div>

	<div>

		<h2 id="download"><?php echo gettext("How to download from the Git repository"); ?>  <span class="r"><a href="#download">#download</a></span></h2>
			<p>
				Libreboot development is facilitated by <em><a href="https://git-scm.com/">git</a></em>, a <em>distributed</em> version control system.
				You will need to install git (most distributions package it in their repositories).
			</p>
			<h3><?php echo gettext("Coreboot distribution. <em>This also contains the documentation</em>:"); ?></h3>
				<p>
					Use this command, to download the repository:<br/>
					<strong>git clone <?php echo $lbGit[0][0]; ?></strong><br/>
					...you can also <a href="<?php echo $lbGit[0][1]; ?>">browse this repository on the web</a>
				</p>
				<p>
					A new directory named <em><strong>libreboot</strong></em> will have been created, containing libreboot.
				</p>
			<h3><?php echo gettext("Website. <em>Documentation is in the other repository</em>:"); ?></h3>
				<p>
					Use this command, to download the repository:<br/>
					<strong>git clone <?php echo $lbwGit[0][0]; ?></strong><br/>
					...you can also <a href="<?php echo $lbwGit[0][1]; ?>">browse this repository on the web</a>
				</p>
				<p>
					A new directory named <em><strong>libreboot-website</strong></em> will have been created, containing the libreboot website files.
				</p>
		<h2><?php echo gettext("Backup repositories"); ?></h2>
			<p>
				Use these if one of the main repositories are down.
			</p>
			<h3><?php echo gettext("Firmware (coreboot distribution)"); ?></h3>
				<?php
					for ($server=1; $server<count($lbGit); $server++) {
				?>
                <p>
					Use this command, to download the repository:<br/>
					<strong>git clone <?php echo $lbGit[$server][0]; ?></strong><br/>
					...you can also <a href="<?php echo $lbGit[$server][1]; ?>">browse this repository on the web</a>
                </p>
				<?php
					}
				?>

			<h3><?php echo gettext("Libreboot website"); ?></h3>
				<?php
					for ($server=1; $server<count($lbwGit); $server++) {
				?>
                <p>
					Use this command, to download the repository:<br/>
					<strong>git clone <?php echo $lbwGit[$server][0]; ?></strong><br/>
					...you can also <a href="<?php echo $lbwGit[$server][1]; ?>">browse this repository on the web</a>
                </p>
				<?php
					}
				?>
			<p>
				<a href="#pagetop">Back to top of page</a>
			</p>

	</div>

	<div>
		<h2 id="sendpatch">How to submit your patches  <span class="r"><a href="#sendpatch">#sendpatch</a></span></h2>
            <h3>Method 0: Use NotABug pull requests</h3>
                <p>
                    NotABug, libreboot's main git hosting provider, now provides a <em>pull requests</em> feature.
                    <a href="https://notabug.org/vimuser/">https://notabug.org/vimuser/</a> has
                    the libreboot and libreboot-website repositories. Create an account on the website, 
                    then view the libreboot or libreboot-website repo and click "fork" and clone your fork. Then
                    commit your patch on top, and push into your repository (we recommend into a non-master branch).
                    NotABug guides you through the process of pushing patches to it.
                </p>
                <p>
                    Once you have pushed your patches, go to the relevant repository
                    on <a href="https://notabug.org/vimuser/">https://notabug.org/vimuser/</a>
                    and click "Pull Requests". Then click &quot;New Pull Request&quot;.
                    Select the relevant branches that you want to submit a pull request for,
                    between the two repositories, and then click &quot;Submit&quot;.
                </p>
                <p>
                    When this is done, Leah Rowe (maintainer of the main repository)
                    or someone else (with push access) will review your patch, and
                    decide whether to merge it. Relevant links to bug trackers
                    for discussing development (especially patch review) are
                    on <a href="../tasks/">../tasks/</a>
                </p>
            <h3><?php echo gettext("Method 1: host a repository"); ?></h3>
				<p>
			        Give the checkout details to <a href="/contrib/">Leah Rowe</a>, along with information on which commits in what branch contain your changes.
				</p>
				<p>
					<strong>Check <a href="#githosting">#githosting</a>, for a list of Git hosting providers that we recommend.</strong>
				</p>
			<h3><?php echo gettext("Method 2: git format-patch -N"); ?></h3>
				<p>
					<?php echo gettext("Use this method (replace N with the number of commits that you made) and send the .patch files to the libreboot project, along with details on what branch and revision these were made on top of."); ?>
                </p>
				<p>
                    Give the checkout details to <a href="/contrib/">Leah Rowe</a>, along with information on which commits in what branch contain your changes.
				</p>
			<p>
				<a href="#pagetop">Back to top of page</a>
			</p>
	</div>

	<div>
		<h2 id="githosting">List of recommended Git hosting providers <span class="r"><a href="#githosting">#githosting</a></span></h2>
			<p>
				There are several that we could recommend:
			</p>
				<ul class="c">
					<li><a href="https://git-scm.com/book/en/v2/Git-on-the-Server-The-Protocols">You!</a> (host your own Git repository, on your own server, on your own internet connection, in your own physical space)</li>
					<li><a href="https://notabug.org/">NotABug.org</a> - the <a href="https://notabug.org/hp/gogs/">source code</a> is also available if you want to run it on your own server.</li>
				</ul>
			<p>
				The libreboot project itself uses all of the above options.
			</p>
			<p>
				Most Git hosting providers distribute non-free JavaScript on their website, but as far as we are aware all of these
				providers are freedom-friendly and reliable to use (and their JavaScript is free). This list will be expanded upon at a later date. The hosting providers
				above are all powered by Free Software, which means that you can also host your own version of the software that they use
				on their website.
			</p>
			<p>
				We generally recommend self-hosting (first option in the list above). Git is a <em>decentralized</em> (distributed) version control system.
				However, not everyone can afford to do this, so using one of the other providers on the list above is also acceptable.
			</p>
			<p>
				<strong><a href="../github/">**PLEASE** DO NOT USE GitHub. Learn more here.</a></strong>
			</p>
			<p>
				<strong><a href="../gitlab/">**PLEASE** DO NOT USE GitLab. Learn more here.</a></strong>
			</p>
			<p>
				<a href="#pagetop">Back to top of page</a>
			</p>
	</div>

	<div>
		<h2 id="contrib"><?php echo gettext("How to use git, for creating patches"); ?>  <span class="r"><a href="#contrib">#contrib</a></span></h2>
			<p>
				Libreboot development is facilitated by <em>git</em>, a <em>distributed</em> version control system that is in wide use today. Git provides many practical benefits,
				making collective development of software very easy.
			</p>
			<p>
				<?php echo gettext("The <a href=\"http://git-scm.com/doc\">git documentation</a> describes how to use git. The following notes include simple tips for how to use git, but it is a good idea to get fully acquainted with git."); ?>
			</p>
			<p>
				<?php echo gettext("Make sure that you configured git so that your name and email address appear in the commits that you create:"); ?><br/>
				<strong>git config --global user.name &quot;Your Name&quot;</strong><br/>
				<strong>git config --global user.email your@emailaddress.com</strong><br/>
				<strong>NOTE: you do not have to use your legal name; we don't care what name you use. You can use any name of your choosing. If you wish to be anonymous (no name), you can also use <em>Libreboot Contributor</em> as your name, and <em>noname@libreboot.org</em> as the email address. <em>We will happily accept anonymous contributions in the libreboot project.</em></strong>
			</p>
			<p>
				<?php echo gettext("The following is also useful:"); ?><br/>
				<strong>git config --global core.editor vim</strong> # NOTE: on most systems, git defaults to using vi anyway. If you switch to vim, make sure it's installed<br/>
				<strong>git config --global color.status auto</strong><br/>
				<strong>git config --global color.branch auto</strong><br/>
				<strong>git config --global color.interactive auto</strong><br/>
				<strong>git config --global color.diff auto</strong>
			</p>
			<p>
				<strong>NOTE: the above steps for colour make git use red/green font colours for showing diffs. If you are red/green colour-blind, please ignore the above steps. The default configuration in git is no-colour (all one colour, usually the default that your terminal uses). If you are colour-blind, git can display in other colours; refer
				to the git documentation.</strong>
			</p>
			<p>
				<?php echo gettext("Clone the git repository, and make your desired changes inside the newly created <em>libreboot</em> directory."); ?>
				<?php echo gettext("You can make one or several commits (as many as you like)."); ?>
				<?php echo gettext("Generally speaking, you should create separate commits on top of each other, for each kind of change."); ?>
			</p>
			<p>
				When working with git, you will need your current working directory to be inside the <em>libreboot</em> directory that was just created.<br/>
				<strong>cd libreboot/</strong>
			</p>
			<p>
				<?php echo gettext("Once you have made your change(s), you can use this to check the status:"); ?><br/>
				<strong>git status</strong>
			</p>

			<p>
				<?php echo gettext("The status command will show any untracked files that you have. Add them using <strong>git add path/to/file</strong>. You should also add any other files that are listed as modified in the git status. If there are deleted files in the git status, you can use <strong>git rm path/to/file</strong>. As long as you have added all the untracked files, it is generally easier to use:"); ?><br/>
				<strong>git commit -a</strong><br/>
				<?php echo gettext("(instead of <strong>git commit</strong>)"); ?>
			</p>
			<p>
				<?php echo gettext("If you need to make a change to the current commit, you can do so with:"); ?><br/>
				<strong>git commit --amend</strong><br/>
				<?php echo gettext("or:"); ?><br/>
				<strong>git commit -a --amend</strong>
			</p>

			<p>
				If you wish to use a different author name for the commit command, add <strong><em>--author=&quot;Author's Name &lt;author's email address&gt;&quot;</em></strong> at the end. This
				could be any name your choosing, or it could be because you are submitting a patch on someone else's
				behalf. <strong>If you wish to be anonymous (no name), you can also use <em>Libreboot Contributor</em> as your name, and <em>noname@libreboot.org</em> as the email address. <em>We will happily accept anonymous contributions in the libreboot project.</em></strong>
			</p>
			<p>
				Check once more that everything you want is added. Use the <strong>git status</strong> command to check for untracked changes/files, and adapt accordingly.
				Once you've committed everything, your changes will appear in a <em>diff</em> format, using this command:<br/>
				<strong>git show</strong><br/>
				Use PgUp/PgDown to navigate the diff output. This uses the <em>less</em> utility, so all the features from that (e.g. keyword search) are also available.
			</p>

			<p>
				<?php echo gettext("In your local git tree, you can use this to check your commits:"); ?><br/>
				<strong>git log</strong>
			</p>
			<p>
				<?php echo gettext("Shortened git logs showing the short commit ID and the commit title, plus info about what branch you are on, and where all your remotes/heads are:"); ?><br/>
				<strong>git config --global --add alias.lol &quot;log --graph --decorate --pretty=oneline --abbrev-commit --all&quot;</strong><br/>
				<?php echo gettext("From then on, you can use:"); ?><br/>
				<strong>git lol</strong><br/>
				<?php echo gettext("This is like <strong>git log</strong>, but it's much better and shows branches, etc."); ?>
			</p>

			<p>
				<a href="#pagetop">Back to top of page</a>
			</p>
	</div>

<?php
	include "../common/footer.php";
?>

</body>
</html>
<?php
	$strHtml = ob_get_clean();
	echo miniHtml($strHtml);
?>
